Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Improve development docs and SliceUnique, remove gomarkdoc #11

Merged
merged 2 commits into from
Aug 29, 2024
Merged

feat: Improve development docs and SliceUnique, remove gomarkdoc #11

merged 2 commits into from
Aug 29, 2024

Conversation

nieomylnieja
Copy link
Collaborator

@nieomylnieja nieomylnieja commented Aug 28, 2024 •
edited
Loading

Motivation

  • Added development instructions and contributing guidelines to the project.
  • Added test coverage utility to Makefile.
  • Removed gomarkdoc usage as it turns out that pkg.go.dev can render testable examples comments well.
  • Improved SliceUnique error messages.
  • Added testable example for SliceUnique.

Release Notes

SliceUnique now reports more readable error messages using ordinal slice index form (e.g. 1st, 2nd, 11th) instead of 0-based slice index.

Breaking Changes

SliceUnique error message has been changed.
Before: elements are not unique, index 0 collides with index 2.
After: elements are not unique, 1st and 3rd elements collide.

@n9-machine-user n9-machine-user added chore Routine or minor duty task patch Bug fixes and security updates labels Aug 28, 2024
@n9-machine-user n9-machine-user added the go Pull requests that update Go code label Aug 29, 2024
@nieomylnieja nieomylnieja changed the title chore: Improve development docs feat: Improve development docs and SliceUnique, remove gomarkdoc Aug 29, 2024
@n9-machine-user n9-machine-user added enhancement New feature or request minor New functionality with at most minor brekaing changes breaking-change Any kind of non-backwards compatible change labels Aug 29, 2024
@nieomylnieja nieomylnieja removed chore Routine or minor duty task patch Bug fixes and security updates labels Aug 29, 2024
@nieomylnieja nieomylnieja merged commit e4a1079 into main Aug 29, 2024
15 checks passed
@nieomylnieja nieomylnieja deleted the improve-docs branch August 29, 2024 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
breaking-change Any kind of non-backwards compatible change enhancement New feature or request go Pull requests that update Go code minor New functionality with at most minor brekaing changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nieomylnieja @n9-machine-user